Closing API - REST icon

Closing API - REST

1.1.x
(0 reviews)

Specs Service Orders IN - REST API

The REST Projects Service Orders IN API allows you to create Service Orders Codex :

Request to send Service Orders data to Codex

POST /rest/v1/service-orders

Security

This API is secured by client_id/client_secret. These parameters are to add in the headers of your call:

- client_id: {client_id provided by Dali}
- client_secret: {client_secret provided by Dali}

Body Example

{
  "serviceOrderHeader": {
    "sourceSystem": "",
    "orderNumber": "",
    "customerNumber": "",
    "functLocationLable": "",
    "equipmentNumber": "",
    "notificationNumber": "",
    "description": "",
    "orderType": "",
    "systemStatusLine": "",
    "userStatusLine": "",
    "maintenanceActivityType": "",
    "companyCode": "",
    "controllingArea": "",
    "businessArea": "",
    "estimatedTotalOrderCost": "",
    "currencyKey": "",
    "priority": "",
    "schedulingType": "",
    "scheduledStartDate": "",
    "scheduledStartTime": "",
    "scheduledEndDate": "",
    "scheduledEndTime": "",
    "earliestStartDate": "",
    "earliestStartTime": "",
    "latestFinishDate": "",
    "latestFinishTime": "",
    "workCenter": "",
    "numberSuperiorOrder": "",
    "plant": "",
    "businessUnit": "",
    "sysCondition": "",
    "languageCode": "",
    "permissibleOrderType": "",
    "refurbishmentOorderInd": "",
    "maintenanceOrderInd": "",
    "plannerGroup": "",
    "actualStartDate": "",
    "actualEndDate": "",
    "maintenancePlant": "",
    "maintenancePlanPlant": "",
    "workCenterLocation": "",
    "plannedStartDate": "",
    "plannedEndDate": "",
    "subCategory": "",
    "attribute1": "",
    "attribute2": "",
    "attribute3": "",
    "reporter": "",
    "reportDate": ""
  },
  "headerLongText": [
    {
      "tagColumn": "",
      "textLine": ""
    }
  ],
  "serviceOrderSpecificData": {
    "assignementType": "",
    "projectNumber": "",
    "settlementType": "",
    "settlementPercentageRate": "",
    "salesOrderNumber": "",
    "salesOrderItem": "",
    "customerOrderNumber": "",
    "customerOrderDate": "",
    "dipProfile": "",
    "statusSystem": "",
    "statusUser": "",
    "actualStartDate": "",
    "actualEndDate": "",
    "nonCompletionCode": "",
    "tpControlRoomOrig": "",
    "tagColumn": "",
    "textLine": ""
  },
  "serviceOrderAddress": {
    "title": "",
    "name1": "",
    "name2": "",
    "name3": "",
    "name4": "",
    "houseNumber": "",
    "street": "",
    "city": "",
    "district": "",
    "region": "",
    "postalCode": "",
    "countryKey": "",
    "firstPhoneNumber": "",
    "languageCode": "",
    "location": ""
  },
  "serviceOrderPartner": [
    {
      "partnerFunction": "",
      "partner": "",
      "description": "",
      "languageCode": "",
      "partnerAddressLanguageCode": ""
    }
  ],
  "operationMaterial": [
    {
      "stockType": "",
      "description": "",
      "stockQuantity": ""
    }
  ]
}

Response of the API

If the request is OK: HTTPS status will be 200:

{
    "header": {
        "apiName": "closing-exp",
        "apiVersion": "1.2.3-env-313103",
        "correlationId": "a4c15410-9761-11ef-85c8-e6473598b41c"
    },
    "data": {
        "message": "The request payload is correct,DALI is starting the process."
    },
    "error": {}
}

If the request is KO: HTTPS status will be 400 or 500

Reviews